FlowDocument

The FlowDocument class represents a flow document with various configurable properties, inheriting from FlowObjectDesigner.

The FlowDocument class is responsible for managing document operations within a workflow. It provides comprehensive functionality for handling forms, document states, and control values. The class implements ILiquidizable for template rendering and includes features for form management, control value manipulation, and document state updates.

Key features:

• Form instance management
• Control value manipulation
• Document state updates
• Document saving and deletion
• Data grid operations
• Unique ID management
• Template rendering support
• Build manager integration
• Deployment URL management

Properties

Name	Description
Key	A unique identifier for the workflow step.
WorkflowCodeInstance	The workflow code instance associated with the flow object.
CachedDMObjects	The cached document management objects related to the flow object.
FormCaption	Specifies the caption of the form associated with the document.
ViewId	Identifies the ID of the view associated with the document.
DocumentId	Represents the unique identifier for the document.
FormName	Represents the name of the form associated with the document.
ProcessName	Represents the name of the process associated with the document.
IsChanged	Indicates whether the document properties have been modified.
TypeCode	The type code associated with the flow object.
Type	Specifies the type of document to be created.
Name	Name for the workflow step.
ViewName	Defines the name of the view linked to the document.
ExistingDocumentPath	Specifies the path to an existing document.
Parameters	Represents a dictionary of parameters associated with the document.
PanelSize	Represents the size of the panel associated with the document.
FileId	Specifies the file ID linked to the document.
DeploymentUrl	Specifies the deployment URL for the document.
FormInstance	The FormInstance class manages a form instance, providing properties and methods for handling form settings, secrets, user events, deployment URL configurations, and controls. It integrates encryption and decryption for secure management of SecretKey and other sensitive data.
BuildManagerSettings	Represents the build manager settings for the workflow.
Caption	The caption dictionary representing localized captions for the flow object.
ProcessId	Defines the process ID associated with the document.
Controls	The Controls class represents a collection of form controls within a client form, providing access through an indexer.
FormId	Identifies the form ID related to the document.

Constructors

Name	Description
FlowDocument(name, workflowData, workflowCodeInstance)	Constructor for the FlowDocument class. Initializes a new instance of the FlowDocument class.
FlowDocument(name, workflowData, workflowCodeInstance)	Initializes a new instance of the FlowDocument class.

Methods

Name	Description
SetExistingDocumentByPathAsync(existingDocumentPath)
SetControlText(controlName, text)	Sets the text of a specified control in the document.
Initialize()	Initializes the document and prepares it for further operations.
SetControlValue(controlName, value)	Sets the value of a specified control in the document.
GetControlValue(controlName)	Retrieves the value of a specified control from the document.

Events

Name	Description
OnBeforeExecution(sender, args)	Occurs before the execution of the workflow step.
OnAfterExecution(sender, args)	Occurs after the execution of the workflow step.

Generic Types

Name	Description
TProperties	Generic type of properties.